home *** CD-ROM | disk | FTP | other *** search
/ The Apple Sales & Market…urce Library 1999 January / ARL Jan 99 CD 2.iso / Application Library / Desktop Publishing⁄Graphics / Creator2 / Other Stuff You Can Install! / Search 3.1.1 / Search® 3.1 CD Installer / SearchÆ 3.1 CD Installer / Multi-Ad SearchÆ 3.1.rsrc / STR#_8322.txt < prev    next >
Text File  |  1996-06-14  |  8KB  |  497 lines
  1.  
  2.  
  3. Remember (procName [, procName]‚Ķ | All)
  4.  
  5. Ignore (procname [, procName]‚Ķ | All)
  6.  
  7. Dispose (varName)
  8.  
  9. New (vwRefNum, varName)
  10.  
  11.  
  12.  
  13. Additional Interpreter Commands:
  14.  
  15.  
  16.  
  17.  
  18.  
  19. DisposeMsg (theMsg)
  20.  
  21. MessageTypeCount (msgType) <- theCount
  22.  
  23. MessageCount <- theCount
  24.  
  25. ReadMessageOfType (theType, theMsg) <- theResult
  26.  
  27. ReadMessage (theMsg) <- theResult
  28.  
  29. MessageSend (theMsg, async)
  30.  
  31. DisposeMsgPtr (msgPtr)
  32.  
  33. NewMsgPtr (blkCount) <- outMsgPtr
  34.  
  35.  
  36.  
  37. SetMyUserName (userName)
  38.  
  39. GetMyUserName <- userName
  40.  
  41. GetIndUserNum (n) <- userNum
  42.  
  43. GetUserNum (userName) <- userNum
  44.  
  45. GetUserName (userNum) <- userName
  46.  
  47. CountUsers <- userCount
  48.  
  49.  
  50.  
  51. Messaging Operations:
  52.  
  53.  
  54.  
  55.  
  56.  
  57. SetPollParams (msg, minTime, maxTime, dlogID, canCancel)
  58.  
  59. GetPollParams <- msg, minTime, maxTime, dlogID, canCancel
  60.  
  61. PopPollProc
  62.  
  63. PushPollProc (@pollProc,@var)
  64.  
  65. PollLocks (theLocks)
  66.  
  67.  
  68.  
  69. LockQuery (lockNum) <- lockInfo
  70.  
  71. LockConflicts (theLocks) <- lockCount, lockList
  72.  
  73. GetOwner <- ownerID
  74.  
  75. SetOwner (ownerID)
  76.  
  77.  
  78.  
  79. ReleaseLock (theLocks)
  80.  
  81. LockStatus (theLocks) <- theStatus
  82.  
  83. GetLockNumber (theLocks) <- theLocks
  84.  
  85.  
  86.  
  87. ExtLockExists (theType, theData, firstByte, count, permission) <- theResult
  88.  
  89. ExtLockTest (theType, theData, firstByte, count, permission) <- theResult
  90.  
  91. ExtLock (theType, theData, firstByte, count, permission, wait) <- theResult
  92.  
  93.  
  94.  
  95. Locking Operations:
  96.  
  97.  
  98.  
  99.  
  100.  
  101. DebugAudit (n)
  102.  
  103. DebugWriteln (n, aStr)
  104.  
  105. DebugWrite (n, aStr)
  106.  
  107. DebugClearTxt (n)
  108.  
  109.  
  110.  
  111. Debugger Functions:
  112.  
  113.  
  114.  
  115.  
  116.  
  117. Decompress (dataHdl) <- theResult
  118.  
  119. Compress (dataHdl) <- theResult
  120.  
  121. Decrypt (@data, dataSize, key)
  122.  
  123. Encrypt (@data, dataSize, key)
  124.  
  125.  
  126.  
  127. Utilities:
  128.  
  129.  
  130.  
  131.  
  132.  
  133. SQGetConnection (fileName, connectFile) <- theResult
  134.  
  135. SQGetIndConnection (fileName, conNum) <- connectFile
  136.  
  137.      {, fieldName, fieldLength}‚Ķ | false
  138.  
  139. SQGetKeyInfo (fileName, keyName) <- keyName, dupAllowed, ULCase, fieldCount
  140.  
  141.      {, fieldName, fieldLength}‚Ķ
  142.  
  143. SQGetIndKeyInfo (fileName, keyNum) <- keyName, dupAllowed, ULCase, fieldCount
  144.  
  145.      fieldCount | false
  146.  
  147. SQGetFieldInfo (fileName, fieldName) <- fieldName, fieldType, fieldLength,
  148.  
  149.      fieldCount
  150.  
  151. SQGetIndFieldInfo (fileName, fieldNum) <- fieldName, fieldType, fieldLength,
  152.  
  153. SQGetFileInfo (fileName) <- fileName, fileType, fieldCount, keyCount, conCount | false
  154.  
  155. SQGetIndFileInfo (fileNum) <- fileName, fileType, fieldCount, keyCount, conCount
  156.  
  157. SQCountFiles <- theResult
  158.  
  159.  
  160.  
  161. Database Schema Queries:
  162.  
  163.  
  164.  
  165.  
  166.  
  167. SBUpdate (blockType, blockID, @data)
  168.  
  169. SBRead (blockType, blockID, @data)
  170.  
  171. SBGetSize (blockType, blockID) <- theResult
  172.  
  173. SBResize (blockType, blockID, newSize)
  174.  
  175. SBDelete (blockType, blockID)
  176.  
  177. SBLockExists (blockType, blockID, permission) <- theResult
  178.  
  179. SBLockTest (blockType, blockID, permission) <- theResult
  180.  
  181. SBGrab (blockType, blockID, permission, wait)
  182.  
  183. SBCreate (blockType, blockID, blockSize, @data)
  184.  
  185.  
  186.  
  187. Static Block Operations:
  188.  
  189.  
  190.  
  191.  
  192.  
  193. REEnd (showProgress, progressProc)
  194.  
  195. RERmveCon (connectFile)
  196.  
  197. REAddCon (connectFile)
  198.  
  199.      dupAllowed)
  200.  
  201. REChgKey (keyName, fldCount {, fldName, fldLength, ascending}‚Ķ, ULCase,
  202.  
  203. RERmveKey (keyName)
  204.  
  205.      dupAllowed)
  206.  
  207. RENewKey (keyName, fldCount {, fldName, fldLength, ascending}‚Ķ, MaintainCount, ULCase,
  208.  
  209. REChgField (fieldName, newType, newLength, newCount)
  210.  
  211. RERmveField (fieldName)
  212.  
  213. RENewField (newName, newType, newLength, newCount)
  214.  
  215. REBegin (fileName)
  216.  
  217. REUpdate (showProgress, progressProc)
  218.  
  219. REUpgrade (showProgess, progressProc)
  220.  
  221.  
  222.  
  223. Reorganization:
  224.  
  225.  
  226.  
  227.  
  228.  
  229. USSetEOF (usRefNum, logEOF)
  230.  
  231. USGetEOF (usRefNum) <- theResult
  232.  
  233. USLockExists (usRefNum, start, count, permission) <- theResult
  234.  
  235. USLockTest (usRefNum, start, count, permission) <- theResult
  236.  
  237. USGrab (usRefNum, start, count, permission, wait)
  238.  
  239. USWrite (usRefNum, count, @buffer)
  240.  
  241. USRead (usRefNum, count, @buffer)
  242.  
  243. USGetPosition (usRefNum) <- theResult
  244.  
  245. USPosition (usRefNum, posMode, position)
  246.  
  247. USClose (usRefNum)
  248.  
  249. USOpen (fileName) <- usRefNum
  250.  
  251.  
  252.  
  253. Unstructured File Operations:
  254.  
  255.  
  256.  
  257.  
  258.  
  259. SRDeleteView (viewName)
  260.  
  261. SRCloseView
  262.  
  263. SRViewNewFile (fName, statusMask)
  264.  
  265. SRViewNewKey (localName, fileName, keyName)
  266.  
  267.      fileName, fieldName)
  268.  
  269. SRViewNewField (localName, fldType, fldCount, fldLength,
  270.  
  271. SROpenView (viewName)
  272.  
  273. SRNewView (viewName)
  274.  
  275.  
  276.  
  277. View Maintenance:
  278.  
  279.  
  280.  
  281.  
  282.  
  283. SRClear (vwRefNum, @viewBuffer)
  284.  
  285. SRInitVwBuff (vwRefNum, @viewBuffer)
  286.  
  287. SRClearCurrent (vwRefNum)
  288.  
  289. SRCurrentRecord (fName) <- theResult
  290.  
  291. SRSetRecID (fileName, theRec)
  292.  
  293. SRGetRecID (fileName) <- theRec
  294.  
  295. SRRestore (vwRefNum, saveRecHdl)
  296.  
  297. SRSave (vwRefNum, saveRecHdl)
  298.  
  299.  
  300.  
  301. SRGetPosition (vwRefNum) <- theResult
  302.  
  303. SRPosition (vwRefNum, thePos, @viewBuffer, permission, wait) <- theResult
  304.  
  305. SRPositionLast (vwRefNum, @viewBuffer, permission, wait) <- theResult
  306.  
  307. SRPositionFirst (vwRefNum, @viewBuffer, permission, wait) <- theResult
  308.  
  309.      wait) <- theResult
  310.  
  311. SRPrevious (vwRefNum, wrap, exactMatch, lastField, @viewBuffer, permission,
  312.  
  313.      wait) <- theResult
  314.  
  315. SRNext (vwRefNum, wrap, exactMatch, lastField, @viewBuffer, permission,
  316.  
  317. SRGetCount (vwRefNum) <- theResult
  318.  
  319.      permission, wait) <- theResult
  320.  
  321. SRFindRange (vwRefNum, @viewBuffer1, @viewBuffer2, lastField, exactMatch,
  322.  
  323.      wait) <- theResult
  324.  
  325. SRFindLast (vwRefNum, @viewBuffer, lastField, exactMatch, permission,
  326.  
  327.      wait) <- theResult
  328.  
  329. SRFindFirst (vwRefNum, @viewBuffer, lastField, exactMatch, permission,
  330.  
  331.  
  332.  
  333.      permission, wait) <- theResult
  334.  
  335. SRDeleteWithPrev (vwRefNum, wrap, exactMatch, lastField, @viewBuffer,
  336.  
  337.      permission, wait) <- theResult
  338.  
  339. SRDeleteWithNext (vwRefNum, wrap, exactMatch, lastField, @viewBuffer,
  340.  
  341. SRDelete (vwRefNum)
  342.  
  343. SRUpdate (vwRefNum, @viewBuffer)
  344.  
  345. SRRead (vwRefNum, @viewBuffer, permission, wait)
  346.  
  347. SRLockExists (vwRefNum, permission) <- theResult
  348.  
  349. SRLockTest (vwRefNum, permission) <- theResult
  350.  
  351. SRGrab (vwRefNum, permission, wait)
  352.  
  353. SRInsert (vwRefNum, @viewBuffer)
  354.  
  355.  
  356.  
  357. SRSize (fileName) <- theResult
  358.  
  359. SRSetBalance (fileName, keyName, balance)
  360.  
  361. SRGetCurrKey (vwRefNum) <- keyName
  362.  
  363. SRSelectKey (vwRefNum, keyName)
  364.  
  365. SRClose (vwRefNum)
  366.  
  367. SROpen (viewName) <- vwRefNum
  368.  
  369.  
  370.  
  371. Structured Record Operations:
  372.  
  373.  
  374.  
  375.  
  376.  
  377. FSetEncryption (fileName, key)
  378.  
  379. FGetTime (fileName) <- crTime, modTime, reorgTime
  380.  
  381. FEmpty (fileName)
  382.  
  383. FDelete (fileName)
  384.  
  385. FLockExists (fileName, permission) <- theResult
  386.  
  387. FLockTest (fileName, permission) <- theResult
  388.  
  389. FGrab (fileName, permission, wait)
  390.  
  391. FConnect (childFile, parentFile)
  392.  
  393. FCreate (fileName, fType)
  394.  
  395.  
  396.  
  397. File Operations:
  398.  
  399.  
  400.  
  401.  
  402.  
  403. ISOUnloadSeg
  404.  
  405.  
  406.  
  407. ISOFlushIO
  408.  
  409. ISOHoldIO
  410.  
  411.  
  412.  
  413. ISOGetTime <- crTime, modTime, reorgTime
  414.  
  415. ISOGetRefNum (fileNum) <- fileRefNum
  416.  
  417. ISOSetFileSize (fileNum, newBlkCount, maxFileSize)
  418.  
  419. ISOGetFileSize (fileNum) <- blksUsed, blksAvailable, maxFileSize
  420.  
  421. ISOSelectFile (fileNum)
  422.  
  423. ISOCreateExtFile (fileName, vRefNum, startFileSize, maxFileSize)
  424.  
  425. ISOCountFiles <- theResult
  426.  
  427.  
  428.  
  429. ISOSetExtProc (@makeProc, @findProc)
  430.  
  431.  
  432.  
  433. ISOPopError
  434.  
  435. ISOPushError (@errProc, @var)
  436.  
  437. ISOErrText (err) <- theText
  438.  
  439. ISOError <- theResult
  440.  
  441.  
  442.  
  443. ISORepair (@problemRec, showProgress) <- repaired
  444.  
  445. ISOCheck (fName, showProgress, fullCheck, @problemRec) <- theResult
  446.  
  447.  
  448.  
  449. ISOIdle
  450.  
  451. ISOChgPassword (oldPass, newPass)
  452.  
  453. ISOResetStatus (fileName, vRefNum) <- theResult
  454.  
  455. ISOClose
  456.  
  457. ISOGetCurrentDBRefNum (VAR theCurrentDBsRefNum) <- theResult
  458.  
  459. ISOSetCurrentDB (aDBREfNumber);
  460.  
  461.      recoverMode, password, forceFind)
  462.  
  463. ISOOpen (fileName, vRefNum, creator, fileType, extdType, imageFileType, permission,
  464.  
  465.      recoverMode, password)
  466.  
  467. ISOCreate (fileName, vRefNum, creator, fileType, extdType, imageFileType, permission,
  468.  
  469.  
  470.  
  471. Database Operations:
  472.  
  473.  
  474.  
  475.      SRSave handles
  476.  
  477.      Lock list handles
  478.  
  479.      View buffers
  480.  
  481. The following can be either an address or a dynamic variable name:
  482.  
  483. Numbers are assumed to be decimal unless prefixed by $.
  484.  
  485. Pointer parameters are specified as hex or decimal addresses and are prefixed by @.
  486.  
  487.  
  488.  
  489.     Boolean: t=TRUE; f=FALSE
  490.  
  491.                  sh=lockShared; ex=lockExclusive
  492.  
  493.     Permissions: rd=readOnly; sc=lockSecure; up=lockUpdate; dl=lockDelete
  494.  
  495. Constants:
  496.  
  497.